/*
 * Copyright 2022-2024 Pavel Castornii.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.techsenger.ansi4j.core.api;

import javax.annotation.concurrent.Immutable;

/**
 *
 * @author Pavel Castornii
 */
@Immutable
public interface Fragment {

    /**
     * Returns type of this fragment.
     *
     * @return
     */
    FragmentType getType();

    /**
     * Text on which base this fragment was created (this is a piece of the whole text).
     *
     * @return
     */
    String getText();

    /**
     * Start index of the fragment text in the whole text, inclusive.
     *
     * @return
     */
    int getStartIndex();

    /**
     * End index of the fragment text in the whole text, exclusive.
     *
     * @return
     */
    int getEndIndex();
}
